Skip to content

Merge Chris's changes into main.#32

Merged
tHarvey303 merged 2 commits intomainfrom
docs_update
Nov 13, 2025
Merged

Merge Chris's changes into main.#32
tHarvey303 merged 2 commits intomainfrom
docs_update

Conversation

@tHarvey303
Copy link
Collaborator

@tHarvey303 tHarvey303 commented Nov 13, 2025

Summary by CodeRabbit

  • Documentation
    • Enhanced notebook documentation with improved wording and grammar corrections.
    • Expanded guidance on feature array customization options, including adding new features, simulating missing data, and transforming parameters for improved model performance.
    • Removed outdated content section from training documentation.
    • Updated reference links in library documentation.

@coderabbitai
Copy link

coderabbitai bot commented Nov 13, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updates across two Jupyter notebooks: SPHINX documentation link formatting, grammar corrections, expanded feature array customization examples, and removal of a "Missing Fluxes" section.

Changes

Cohort / File(s) Summary
Documentation Notebook Updates
docs/source/library_gen/bring_your_own_library.ipynb, docs/source/sbi_train/feature_array.ipynb
First notebook adds labeled SPHINX documentation link and removes Python metadata. Second notebook fixes grammar ("an model" → "a model", "can included" → "can include"), expands feature array customization options with three new topics (adding features, simulating missing data, transforming parameters), and removes the "Missing Fluxes" section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Documentation changes are isolated to notebook markdown cells with no code logic
  • Grammar corrections are straightforward and self-evident
  • Content additions follow existing bullet-point structure
  • Explicit section removal is low-risk

Poem

🐰 A hop through the docs, so neat and so fine,
With grammar now polished and references aligned,
New features shine bright in their customized way,
While old missing fluxes have hopped far away!

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs_update

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5be8dcf and fe9b319.

📒 Files selected for processing (2)
  • docs/source/library_gen/bring_your_own_library.ipynb (2 hunks)
  • docs/source/sbi_train/feature_array.ipynb (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@tHarvey303 tHarvey303 merged commit 67b361a into main Nov 13, 2025
4 checks passed
@tHarvey303 tHarvey303 deleted the docs_update branch November 13, 2025 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants